通过发起一次退款请求创建一个新的 refund
对象,只能对已经发生付款并且没有全额退款的 order
对象发起退款。当进行全额退款之前,可以进行多次退款,直至全额退款。每次退款成功后,会发送 Webhooks 通知。
订单退款支持以下功能:
charge
进行部分或全额退款。charge
进行全额退款。请求参数 | 描述 |
---|---|
ORDER_ID required string | 需要退款的 order 对象的 id ,该参数仅需要填写在请求地址内。 |
description required string | 退款详情,最多 255 个 Unicode 字符。针对 cmb_wallet & cmb_pc_qr 渠道最多支持 99 字节;针对 jdpay_wap 渠道最多支持 128 字节;针对 paypal 渠道最多支持 30 字节;针对 coolcredit 渠道最多支持 100 Unicode 字符。 |
charge optional string | 需要退款的 charge 对象的 id ,不填表示对所有包含的 charge 对象全额退款。 |
charge_amount optional int | 退款金额,单位分。必须小于等于可退款金额,默认为全额退款。仅当填写 charge 参数时有效,表示对此 charge 对象进行退款的金额。 |
refund_mode optional string | 退款方式。原路退回:to_source ,退至余额:to_balance 。默认为原路返回。如果对渠道为 balance 的 charge 对象退款,两者效果相同。 |
funding_source optional string | 微信及 QQ 类退款资金来源。取值范围:unsettled_funds :使用未结算资金退款;recharge_funds :微信-使用可用余额退款,QQ-使用可用现金账户资金退款。注:默认值 unsettled_funds ,该参数对于微信渠道的退款来说仅适用于微信老资金流商户使用,包括 wx 、wx_pub 、wx_pub_qr 、wx_lite 、wx_wap 、wx_pub_scan 六个渠道;新资金流退款资金默认从基本账户中扣除。该参数仅在请求退款,传入该字段时返回。 |
royalty_users optional list | 退分润的用户信息列表。不填默认退还所有可退分润,否则需要填写所有分润的用户信息。使用分润模板的订单不需要填写此参数。具体可参考下表。 |
metadata optional hash | 详见 元数据。 |
royalty_users 参数 | 描述 |
---|---|
user required string | 退分润的 user 对象的 id 。 |
amount_refunded optional int | 退分润的金额,单位为分;不退分润时填 "0"。 默认退还所有可退分润。 |
返回
返回一个 order
对象列表,或者返回一个错误,详见 错误。
POST https://api.pingxx.com/v1/orders/{ORDER_ID}/order_refunds
待补充
待补充
待补充
待补充
待补充
待补充
待补充
curl https://api.pingxx.com/v1/orders/2111608270000005209/order_refunds \ -H "Pingplusplus-Request-Timestamp: 1475029155" \ -H "Pingplusplus-Signature: SIGNATURE" \ -u sk_test_ibbTe5jLGCi5rzfH4OqPW9KC: -d '{ "description":"test-refund" }'
待补充
待补充
待补充
待补充
待补充
待补充
待补充
{
"object": "list",
"url": "/v1/orders/2111608270000005209/order_refunds",
"has_more": false,
"data": [
{
"id": "re_y1u944PmfnrTHyvnL0nD0iD1",
"object": "refund",
"order_no": "y1u944PmfnrTHyvnL0nD0iD1",
"amount": 800,
"created": 1499930518,
"succeed": true,
"status": "succeeded",
"time_succeed": 1499930518,
"description": "Refund Description",
"failure_code": null,
"failure_msg": null,
"metadata": {},
"charge": "ch_8SCSCCn90ir1bb54m5fjbnX5",
"charge_order_no": "2017071102122327",
"transaction_no": "2004450349201512090096425284",
"extra": {}
}
]
}